1 Objetivos

Los principales objetivos de esta práctica son los siguientes:

  1. Familiarizarse con las siguientes abstracciones de Linux:
    • Módulos cargables
    • Sistema de ficheros /proc
    • Listas enlazadas del kernel
    • Gestión básica de memoria dinámica en el kernel
  2. Afrontar las dificultades de la programación en espacio de kernel
  3. Conocer los fundamentos de la depuración en Linux mediante trazado con Ftrace

La mayor parte de las prácticas de este curso constan de un pequeño proyecto de desarrollo que se describe en la sección Desarrollo de la Práctica (sección 3 en este guión). Como fase preparatoria para ese proyecto es preciso realizar previamente una serie de ejercicios sencillos que se describen a continuación.

2 Ejercicios

2.1 Ejercicio 1

Muchas funciones de la API del kernel Linux, como por ejemplo alloc_chrdev_region() o la propia función de carga de un módulo del kernel, devuelven un número entero que indica si se produjo o no un error al ejecutar la función. El valor cero indica que la función se ha ejecutado con éxito. El retorno de un número negativo refleja que se ha producido un error, que se codifica con el propio valor de retorno (número comprendido entre -1 y -511). La definición de estos códigos de error (como números positivos) se encuentra en los siguientes ficheros de cabecera del kernel:

  • <uapi/asm-generic/errno-base.h> (errores clásicos)
  • <uapi/asm-generic/errno.h>

Consulta los citados ficheros de cabecera usando el buscador de las fuentes del kernel Elixir Bootlin, usando el siguiente enlace: https://elixir.bootlin.com/linux/v5.10.92/source. Estos ficheros se encuentran en el directorio include/uapi/asm-generic

Modifica alguno de los módulos del kernel de ejemplo para que la función de carga devuelva uno de estos errores (p.ej., return -EINVAL; ) ¿Qué sucede al intentar cargar el módulo cuando esta función devuelve un número negativo? ¿Es posible descargar el módulo a continuación con rmmod?

2.2 Ejercicio 2

Estudiar el mecanismo de paso de parámetros a módulos del kernel, que se ilustra en el módulo de ejemplo Hello5. Para más información sobre el paso de parámetros, se han de consultar las siguientes fuentes:

  1. Fichero de cabecera <linux/moduleparam.h>
  2. Sección 4.5 de “The Linux Kernel Module Programming Guide”

2.3 Ejercicio 3

Estudiar la implementación del módulo de ejemplo “Clipboard”, que exporta una entrada /proc. Al cargar/descargar el módulo se creará/eliminará el fichero especial /proc/clipboard, que puede emplearse como un portapapeles (clipboard) del sistema.

Nota: Antes de comenzar a estudiar el código del ejemplo se recomienda cargar el módulo y realizar escrituras y lecturas sucesivas sobre /proc/clipboard (con echo <cadena> > /proc/clipboard y cat /proc/clipboard ). Esto permitirá averiguar rápidamente la funcionalidad del módulo Clipboard.

2.4 Ejercicio 4

En el directorio del módulo de ejemplo Clipboard pueden encontrarse dos ficheros de GNU Make: Makefile y Makefile.cross. El segundo de ellos sirve para realizar compilación cruzada del módulo del kernel para la Raspberry Pi desde nuestro host de desarrollo (la máquina virtual de Debian).

Este ejercicio consiste en realizar una compilación cruzada del módulo del kernel Clipboard para la Raspberry Pi y probar el fichero .ko resultante de dicha compilación en la placa. Para ello han de seguirse los siguientes pasos:

  1. Abrir un navegador web en la máquina virtual y descargar el fichero linux-raspberry.tgz usando este enlace. El fichero comprimido contiene un kernel Linux ya compilado para la Raspberry Pi, que nos permite realizar compilación cruzada de módulos del kernel.

  2. Extraer el fichero comprimido en el HOME del usuario kernel. (Se asume que el fichero descargado se almacena en ~/Descargas).

  1. Instalar el compilador cruzado:
  1. Ir al directorio Clipboard y borrar ficheros resultantes de compilaciones previas usando el Makefile convencional:
  1. Generar el .ko adecuado para el kernel de la Raspberry pi usando el comando make -f Makefile.cross desde el mismo directorio donde nos encontramos.
  • Nótese que con la opción -f de GNU Make se escoge manualmente el fichero Makefile para realizar la compilación.
  1. Finalmente, copiar el fichero .ko a la Raspberry Pi usando scp y probar dicho módulo en la placa
  • Comando de copia del fichero al directorio HOME del usuario pi en la placa: scp clipboard.ko pi@pi:.
  • Introducir la contraseña “raspberry” cuando el comando scp lo solicite.

2.5 Ejercicio 5 (Introducción a Ftrace)

Ftrace es una herramienta que permite realizar depuración e inspección del funcionamiento del kernel Linux mediante trazado (tracing). Fundamentalmente, se utiliza realizando lecturas y escrituras en un conjunto de entradas en el sistema de ficheros debugfs. Estas entradas se encuentran bajo /sys/kernel/debug/tracing y sólo son accesibles directamente por el usuario root .

La herramienta está construida de forma modular, y su funcionalidad está encapsulada en un conjunto de tracers, como nop, function y function_graph.

En este breve tutorial analizaremos la funcionalidad más básica de Ftrace mediante una introducción al uso de los tracers más sencillos.

2.5.1 Entradas básicas de ftrace

Las entradas de Ftrace sólo estarán accesibles en un sistema si se cumplen los siguientes requisitos:

  1. El kernel en ejecución ha sido compilado con soporte de ftrace (CONFIG_FTRACE=y)

  2. Y debugfs está montado (en muchas distribuciones de Linux, como Debian, se monta automáticamente durante el proceso de arranque).

Comenzaremos accediendo al directorio de Ftrace como root:

La siguiente tabla describe el propósito de las entradas básicas de Ftrace:

Entrada Descripción
tracing_on Permite activar/desactivar ftrace o consultar estado actual. Escribir la cadena “1” para activar ftrace o “0” para desactivarlo.
trace Al leer de esta entrada se muestran los mensajes almacenados en los buffers de ftrace (un buffer por CPU)
trace_pipe Similar a trace, pero además los buffers se vacían al mostrar su contenido (semántica productor/consumidor)
available_tracers Lista el conjunto de tracers disponibles
current_tracer Permite consultar/modificar el tracer activo leyendo/escribiendo en la entrada
available_filters Lista el conjunto de funciones del kernel o de los módulos cargados que pueden “filtrarse” al usar el tracer function
set_ftrace_filter Permite establecer la función (o funciones) para las que ftrace insertará un mensaje en el buffer cuando éstas sean invocadas.

2.5.2 nop tracer y trace_printk()

El tracer por defecto de Ftrace es nop. Captura únicamente los mensajes que el kernel o los módulos imprimen con la función trace_printk(). Esta función se usa de forma similar a printf(), pero con la salvedad de que mensaje impreso se almacena en un buffer interno de ftrace.

La implementación de trace_printk()es mucho más eficiente que la de printk(), por lo que su uso es más aconsejable que printk() para la depuración del kernel. Además, si ftrace está desactivado, no tiene efecto (modo silencioso) .

Para ilustrar el uso de trace_printk() realizaremos una modificación en el módulo de ejemplo Clipboard. El objetivo es hacer que este módulo muestre un mensaje con trace_printk() y capturar dicho mensaje con ftrace. La modificación consiste en (1) incluir el fichero de cabecera <linux/ftrace.h> y (2) añadir una llamada a trace_printk() al final de la función clipboard_write():

Ahora procederemos a compilar y cargar el módulo del kernel:

Para ver el efecto de las modificaciones realizadas abriremos dos ventanas de terminal. En la primera ventana, en la que iniciaremos una sesión como root, nos aseguraremos de que ftrace y el tracer nop están activos, y realizaremos una lectura del fichero trace_pipe con cat(lectura bloqueante). En la segunda ventana, donde no es necesario iniciar sesión como root, escribiremos la cadenas “Test” y “Something” (una detrás de la otra) al fichero especial /proc/clipboard. Las acciones realizadas en la segunda ventana de terminal harán que se muestren mensajes por la primera (salida de cat trace_pipe) .

Terminal 1

Terminal 2

2.5.3 Tracer function

El tracer function de Ftrace imprime automáticamente un mensaje en el buffer de ftrace cuando se ejecuta cierta función del kernel. Esto permite ver qué funciones núcleo se invocan sin modificar el código del kernel o de un módulo cargable que desee estudiarse o depurarse.

El tracer function soporta la creación de filtros de funciones. Para crear un filtro se ha de escribir el nombre o nombres de las funciones a trazar en la entrada set_ftrace_filter de Ftrace. El listado de funciones que pueden seleccionarse se puede obtener leyendo del fichero especial available_filter_functions. Cabe destacar que por defecto no hay ningún filtro configurado para el l tracer function, por lo que el comportamiento predeterminado es trazar todas las funciones del kernel. Como esto introduce mucha sobrecarga en el sistema, la creación de un filtro ad-hoc es la opción recomendada. Además durante la configuración de dicho filtro es aconsejable desactivar temporalmente ftrace medianteecho 0 > tracing_on.

Para ilustrar el uso del tracer function configuraremos Ftrace para que imprima un mensaje cuándo se invoca la función clipboard_read() del módulo de ejemplo Clipboard. Esto no requiere modificar el código del módulo del kernel. Para configurar el tracer function como deseamos será necesario seguir los siguientes pasos, ejecutando como root los comandos que se muestran a continuación (se asume que el directorio de trabajo es /sys/kernel/debug/tracing:

  1. Desactivar temporalmente Ftrace

  2. Activar function tracer y comprobar que se activó correctamente:

  1. Preparar filtro de ftrace para trazar las invocaciones de la función clipboard_read()

  2. Reactivar ftrace

Una vez configurado el tracer function procederemos a abrir dos ventantas de terminal. En una de ellas (como root) procederemos a leer de la entrada trace_pipe de Ftrace con cat. En la segunda ventana, ejecutaremos cat /proc/clipboard:

Terminal 1

Terminal 2

Como se puede observar clipboard_read() se invoca dos veces al ejecutar cat /proc/clipboard. ¿A qué se debe esto?

3 Desarrollo de la práctica

En esta práctica se ha de implementar un módulo del kernel modlist.c que gestione una lista enlazada de enteros, empleando las siguientes definiciones globales:

Cuando el módulo se cargue/descargue se creará/eliminará automáticamente el fichero especial /proc/modlist. Esta entrada /proc permitirá insertar, eliminar y consultar los elementos de la lista desde espacio de usuario (leyendo o escribiendo en dicho fichero).

La memoria asociada a los nodos de la lista debe gestionarse de forma dinámica empleando kmalloc() y kfree(). Al descargar el módulo, éste ha de ocuparse de borrar y liberar la memoria de todos los elementos de la lista, si la lista no está vacía.

Para realizar modificaciones de la lista enlazada el usuario escribirá cadenas de caracteres (comandos) con un formato específico, como se indica a continuación:

  1. Inserción de número (ejemplo 10) al final de la lista:
    • echo add 10 > /proc/modlist
  2. Eliminación de número de la lista (número 7 en el ejemplo):
    • echo remove 7 > /proc/modlist
    • Borra todas las ocurrencias de ese elemento en la lista
  3. Borrado de todos los elementos de la lista:
    • echo cleanup > /proc/modlist

Para la implementación de estos “comandos” en la write callback de la entrada /proc/modlist se aconseja utilizar la función sscanf(). Para más infomación sobre esta función se han de consultar las páginas de manual: man 3 sscanf.

Finalmente el módulo del kernel permitirá mostrar los elementos de la lista leyendo de /proc/modlist con el comando cat.

3.1 Ejemplo de ejecución

3.2 Ayuda para la implementación: modlist_read()

A continuación se proporciona una posible implementación de la operación de lectura de la lista:

Esta implementación tiene una vulnerabilidad de desbordamiento de buffer (acceso potencial más allá de los límites de un buffer). Intenta identificar donde está presente dicha vulnerabilidad y trata de subsanarla.

3.3 Partes opcionales de la práctica

Parte opcional 1. Probar que la práctica funciona correctamente sobre la Raspberry Pi, generando un fichero .ko mediante compilación cruzada, como en el Ejercicio 4.

Parte opcional 2. Modificar el módulo de la práctica para que la lista gestionada sea de cadenas de caracteres, y su memoria se reserve con kmalloc(). Para esta variante de la práctica se aconseja la inclusión de sentencias de compilación condicional para mantener en un mismo fichero fuente las implementaciones del módulo con lista de enteros (básica) y lista de cadenas de caracteres (opcional), como en el siguiente ejemplo:

Emplear este tipo de sentencias de preprocesador permite escoger la versión de la práctica a compilar, definiendo el símbolo PARTE_OPCIONAL u omitiendolo en tiempo de compilación. Los símbolos de preprocesador se especifican con la opción -D, y, en el caso de los módulos cargables, a través de la variable de entorno EXTRA_CFLAGS que reconoce el sistema de construcción de módulos. Así por ejemplo, para activar la compilación de la parte opcional debería usarse el siguiente comando.